<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>blmc_drivers: /workspace/software/workspace/src/catkin/hardware/blmc_drivers/include/blmc_drivers/devices/analog_sensor.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">blmc_drivers
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('analog__sensor_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">analog_sensor.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="analog__sensor_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;real_time_tools/timer.hpp&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &quot;real_time_tools/threadsafe/threadsafe_timeseries.hpp&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="device__interface_8hpp.html">blmc_drivers/devices/device_interface.hpp</a>&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="motor__board_8hpp.html">blmc_drivers/devices/motor_board.hpp</a>&quot;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblmc__drivers.html">blmc_drivers</a></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classblmc__drivers_1_1AnalogSensorInterface.html">   27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html">AnalogSensorInterface</a>: <span class="keyword">public</span> <a class="code" href="classblmc__drivers_1_1DeviceInterface.html">DeviceInterface</a></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;{</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">   33</a></span>&#160;    <span class="keyword">typedef</span> real_time_tools::ThreadsafeTimeseries&lt;double&gt; <a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">ScalarTimeseries</a>;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keyword">virtual</span> std::shared_ptr&lt;const ScalarTimeseries&gt; <a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html#afd694f79c9fec5a35984d468f59f315c">get_measurement</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classblmc__drivers_1_1AnalogSensorInterface.html#a809cd9b86ae1cb9119a2ad025163afa9">   48</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html#a809cd9b86ae1cb9119a2ad025163afa9">~AnalogSensorInterface</a>() {}</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;};</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classblmc__drivers_1_1AnalogSensor.html">   54</a></span>&#160;<span class="keyword">class </span><a class="code" href="classblmc__drivers_1_1AnalogSensor.html">AnalogSensor</a>: <span class="keyword">public</span> <a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html">AnalogSensorInterface</a></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;{</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  </div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  <a class="code" href="classblmc__drivers_1_1AnalogSensor.html">AnalogSensor</a>(std::shared_ptr&lt;MotorBoardInterface&gt; board, <span class="keywordtype">bool</span> sensor_id);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <span class="keyword">virtual</span> std::shared_ptr&lt;const ScalarTimeseries&gt; <a class="code" href="classblmc__drivers_1_1AnalogSensorInterface.html#afd694f79c9fec5a35984d468f59f315c">get_measurement</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  std::shared_ptr&lt;MotorBoardInterface&gt; board_;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  <span class="keywordtype">size_t</span> sensor_id_;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;};</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;}</div><div class="ttc" id="classblmc__drivers_1_1AnalogSensorInterface_html_afd694f79c9fec5a35984d468f59f315c"><div class="ttname"><a href="classblmc__drivers_1_1AnalogSensorInterface.html#afd694f79c9fec5a35984d468f59f315c">blmc_drivers::AnalogSensorInterface::get_measurement</a></div><div class="ttdeci">virtual std::shared_ptr&lt; const ScalarTimeseries &gt; get_measurement() const =0</div><div class="ttdoc">Get the measurement object which is the list of time stamped data. </div></div>
<div class="ttc" id="namespaceblmc__drivers_html"><div class="ttname"><a href="namespaceblmc__drivers.html">blmc_drivers</a></div><div class="ttdoc">This namespace is the standard namespace of the package. </div><div class="ttdef"><b>Definition:</b> analog_sensors.cpp:15</div></div>
<div class="ttc" id="classblmc__drivers_1_1AnalogSensorInterface_html"><div class="ttname"><a href="classblmc__drivers_1_1AnalogSensorInterface.html">blmc_drivers::AnalogSensorInterface</a></div><div class="ttdoc">AnalogSensorInterface class is a simple abstract interface for using blmc analog measurements. </div><div class="ttdef"><b>Definition:</b> analog_sensor.hpp:27</div></div>
<div class="ttc" id="classblmc__drivers_1_1DeviceInterface_html"><div class="ttname"><a href="classblmc__drivers_1_1DeviceInterface.html">blmc_drivers::DeviceInterface</a></div><div class="ttdoc">this class exists purely for logical reasons, it does not in itself implement anything. </div><div class="ttdef"><b>Definition:</b> device_interface.hpp:36</div></div>
<div class="ttc" id="classblmc__drivers_1_1AnalogSensorInterface_html_a809cd9b86ae1cb9119a2ad025163afa9"><div class="ttname"><a href="classblmc__drivers_1_1AnalogSensorInterface.html#a809cd9b86ae1cb9119a2ad025163afa9">blmc_drivers::AnalogSensorInterface::~AnalogSensorInterface</a></div><div class="ttdeci">virtual ~AnalogSensorInterface()</div><div class="ttdoc">Destroy the AnalogSensorInterface object. </div><div class="ttdef"><b>Definition:</b> analog_sensor.hpp:48</div></div>
<div class="ttc" id="classblmc__drivers_1_1AnalogSensorInterface_html_a4e4a853aa044b7d3afbaa3fe20477602"><div class="ttname"><a href="classblmc__drivers_1_1AnalogSensorInterface.html#a4e4a853aa044b7d3afbaa3fe20477602">blmc_drivers::AnalogSensorInterface::ScalarTimeseries</a></div><div class="ttdeci">real_time_tools::ThreadsafeTimeseries&lt; double &gt; ScalarTimeseries</div><div class="ttdoc">This is just a short cut for the time series types. </div><div class="ttdef"><b>Definition:</b> analog_sensor.hpp:33</div></div>
<div class="ttc" id="motor__board_8hpp_html"><div class="ttname"><a href="motor__board_8hpp.html">motor_board.hpp</a></div><div class="ttdoc">License BSD-3-Clause </div></div>
<div class="ttc" id="classblmc__drivers_1_1AnalogSensor_html"><div class="ttname"><a href="classblmc__drivers_1_1AnalogSensor.html">blmc_drivers::AnalogSensor</a></div><div class="ttdoc">AnalogSensor class is the implementation of the above interface. </div><div class="ttdef"><b>Definition:</b> analog_sensor.hpp:54</div></div>
<div class="ttc" id="device__interface_8hpp_html"><div class="ttname"><a href="device__interface_8hpp.html">device_interface.hpp</a></div><div class="ttdoc">License BSD-3-Clause </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80e6cdd9bbc895bd262b4f65e652822c.html">catkin</a></li><li class="navelem"><a class="el" href="dir_dace45749abc688185d44e8b166728a5.html">hardware</a></li><li class="navelem"><a class="el" href="dir_87d2711f33d814f4f77c208b3c1f3ba9.html">blmc_drivers</a></li><li class="navelem"><a class="el" href="dir_816dc94020a36d1af25b1f5614889f22.html">include</a></li><li class="navelem"><a class="el" href="dir_a56b819f7914f14382554b99ca83f1d8.html">blmc_drivers</a></li><li class="navelem"><a class="el" href="dir_b47d905e4c85065ffdd69d9f780e266d.html">devices</a></li><li class="navelem"><a class="el" href="analog__sensor_8hpp.html">analog_sensor.hpp</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
